/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup CryptoMacApi
 * @{
 *
 * @brief 为应用提供MAC算法接口。
 *
 * @since 20
 */

/**
 * @file crypto_mac.h
 *
 * @brief 定义MAC接口。
 *
 * @library libohcrypto.so
 * @include <CryptoArchitectureKit/crypto_mac.h>
 * @kit CryptoArchitectureKit
 * @syscap SystemCapability.Security.CryptoFramework
 * @since 20
 */

#ifndef CRYPTO_MAC_H
#define CRYPTO_MAC_H

#include "crypto_common.h"
#include "crypto_sym_key.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 定义MAC结构。
 *
 * @since 20
 */
typedef struct OH_CryptoMac OH_CryptoMac;

/**
 * @brief 定义MAC算法参数类型。
 *
 * @since 20
 */
typedef enum {
    /** HMAC消息认证码使用的摘要函数的算法名称，例如SHA256。*/
    CRYPTO_MAC_DIGEST_NAME_STR = 0,

    /** CMAC消息认证码使用的对称加密算法名称，例如AES256。*/
    CRYPTO_MAC_CIPHER_NAME_STR = 1,
} CryptoMac_ParamType;

/**
 * @brief 根据给定的算法名称创建MAC实例。
 *
 * @param algoName 用于生成MAC实例的算法名称。\n
 * 例如"HMAC"、"CMAC"。
 * @param ctx MAC实例。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERATION_ERROR：调用三方算法库API出错。
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoMac_Create(const char *algoName, OH_CryptoMac **ctx);

/**
 * @brief 设置MAC参数。
 *
 * @param ctx MAC实例。
 * @param type MAC参数类型。
 * @param value MAC参数。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERATION_ERROR：调用三方算法库API出错。
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoMac_SetParam(OH_CryptoMac *ctx, CryptoMac_ParamType type, const Crypto_DataBlob *value);

/**
 * @brief 使用对称密钥初始化MAC实例。
 *
 * @param ctx MAC实例。
 * @param key 对称密钥。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERATION_ERROR：调用三方算法库API出错。
 * @see OH_CryptoMac_Update
 * @see OH_CryptoMac_Final
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoMac_Init(OH_CryptoMac *ctx, const OH_CryptoSymKey *key);

/**
 * @brief 更新MAC实例。
 *
 * @param ctx MAC实例。
 * @param in 需要更新的数据。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERATION_ERROR：调用三方算法库API出错。
 * @see OH_CryptoMac_Init
 * @see OH_CryptoMac_Final
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoMac_Update(OH_CryptoMac *ctx, const Crypto_DataBlob *in);

/**
 * @brief 完成MAC操作。
 *
 * @param ctx MAC实例。
 * @param out MAC值。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERATION_ERROR：调用三方算法库API出错。
 * @see OH_CryptoMac_Init
 * @see OH_CryptoMac_Update
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoMac_Final(OH_CryptoMac *ctx, Crypto_DataBlob *out);

/**
 * @brief 获取MAC长度。
 *
 * @param ctx MAC实例。
 * @param length MAC长度。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERATION_ERROR：调用三方算法库API出错。
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoMac_GetLength(OH_CryptoMac *ctx, uint32_t *length);

/**
 * @brief 销毁MAC实例。
 *
 * @param ctx MAC实例。
 * @since 20
 */
void OH_CryptoMac_Destroy(OH_CryptoMac *ctx);

#ifdef __cplusplus
}
#endif

#endif /* CRYPTO_MAC_H */
/** @} */
